<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>dfp_api.PlacementService.PlacementService</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="dfp_api-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/google-api-dfp-python/">DFP API Python Client Library</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="dfp_api-module.html">Package&nbsp;dfp_api</a> ::
        <a href="dfp_api.PlacementService-module.html">Module&nbsp;PlacementService</a> ::
        Class&nbsp;PlacementService
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="dfp_api.PlacementService.PlacementService-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PlacementService</h1><p class="nomargin-top"><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">PlacementService</strong>
</pre>

<hr />
<p>Wrapper for PlacementService.</p>
  <p>The Placement Service provides methods for creating, updating and 
  retrieving placements.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">headers</span>,
        <span class="summary-sig-arg">config</span>,
        <span class="summary-sig-arg">op_config</span>,
        <span class="summary-sig-arg">lock</span>,
        <span class="summary-sig-arg">logger</span>)</span><br />
      Inits PlacementService.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#CreatePlacement" class="summary-sig-name">CreatePlacement</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">placement</span>)</span><br />
      Create a new placement.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.CreatePlacement">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#CreatePlacements" class="summary-sig-name">CreatePlacements</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">placements</span>)</span><br />
      Create a list of new placements.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.CreatePlacements">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#GetPlacement" class="summary-sig-name">GetPlacement</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">placement_id</span>)</span><br />
      Return the placement uniquely identified by the given id.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.GetPlacement">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#GetPlacementsByStatement" class="summary-sig-name">GetPlacementsByStatement</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filter_statement</span>)</span><br />
      Return the placements that match the given statement.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.GetPlacementsByStatement">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#PerformPlacementAction" class="summary-sig-name">PerformPlacementAction</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">action</span>,
        <span class="summary-sig-arg">filter_statement</span>)</span><br />
      Perform action on placements that match the given statement.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.PerformPlacementAction">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#UpdatePlacement" class="summary-sig-name">UpdatePlacement</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">placement</span>)</span><br />
      Update the specified placement.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.UpdatePlacement">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="dfp_api.PlacementService.PlacementService-class.html#UpdatePlacements" class="summary-sig-name">UpdatePlacements</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">placements</span>)</span><br />
      Update a list of specified placements.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.UpdatePlacements">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">headers</span>,
        <span class="sig-arg">config</span>,
        <span class="sig-arg">op_config</span>,
        <span class="sig-arg">lock</span>,
        <span class="sig-arg">logger</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Inits PlacementService.

Args:
  headers: dict dictionary object with populated authentication
           credentials.
  config: dict dictionary object with populated configuration values.
  op_config: dict dictionary object with additional configuration values for
             this operation.
  lock: thread.lock the thread lock
  logger: Logger the instance of Logger

</pre>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="CreatePlacement"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">CreatePlacement</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">placement</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.CreatePlacement">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Create a new placement.

Args:
  placement: dict a placement to create.

Returns:
  tuple response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="CreatePlacements"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">CreatePlacements</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">placements</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.CreatePlacements">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Create a list of new placements.

Args:
  placements: list the placements to create.

Returns:
  tuple The response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="GetPlacement"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetPlacement</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">placement_id</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.GetPlacement">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Return the placement uniquely identified by the given id.

Args:
  placement_id: str ID of the placement, which must already exist.

Returns:
  tuple response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="GetPlacementsByStatement"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetPlacementsByStatement</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filter_statement</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.GetPlacementsByStatement">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Return the placements that match the given statement.

Args:
  filter_statement: dict Publisher Query Language statement used to filter a
                    set of placements.

Returns:
  tuple response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="PerformPlacementAction"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">PerformPlacementAction</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">action</span>,
        <span class="sig-arg">filter_statement</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.PerformPlacementAction">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Perform action on placements that match the given statement.

Args:
  action: dict the action to perform.
  filter_statement: dict Publisher Query Language statement.

Returns:
  tuple response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="UpdatePlacement"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">UpdatePlacement</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">placement</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.UpdatePlacement">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Update the specified placement.

Args:
  placement: dict an placement to update.

Returns:
  tuple response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="UpdatePlacements"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">UpdatePlacements</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">placements</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="dfp_api.PlacementService-pysrc.html#PlacementService.UpdatePlacements">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Update a list of specified placements.

Args:
  placements: list the placements to update.

Returns:
  tuple response from the API method.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="dfp_api-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/google-api-dfp-python/">DFP API Python Client Library</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
